Get a team by ID

GET 
/api/teams/:id

Get a team by ID

Request

Path Parameters

id integerrequired

Responses

200

A team object

application/json

Schema

Schema

id int64

Unique identifier of the team

addresses object[]
The addresses list of the team
Array [
id string
name stringrequired
The name of the address (possible suggested values: billing, shipping, main, etc...)
address stringrequired
The full complete address (street, number, city, postcode, country)
model_type stringrequired
The model type of the address (possible values: \App\Models\Team, \App\Models\User, \App\Models\Product))
model_id stringrequired
The model ID of the related model_type (possible value is the ID of the related model)
country string
role stringrequired
Role of the address (possible suggested values: billing, shipping, main, etc...)
organization string
Organization name related to the address (if different from Team Name)
name_prefix string
Prefix of the name (e.g. Mr, Mrs, etc...)
name_suffix string
Suffix of the name (e.g. Jr, Sr, etc...)
first_name string
First name of the address
last_name string
Last name of the address
street string
Street of the address
building_number string
Building number of the address
building_flat string
Building flat of the address
city string
City of the address
city_prefix string
City prefix of the address
city_suffix string
City suffix of the address
state string
State of the address
state_code string
State code of the address
postcode string
Postcode of the address
lat string
Latitude of the address
lng string
Longitude of the address
line1 string
Address line 1 (will be automatically generated from the address field)
line2 string
Address line 2 (will be automatically generated from the address field)
line3 string
Address line 3 (will be automatically generated from the address field)
created_at string
Date of creation of the address
updated_at string
Date of last update of the address
]
contacts object[]
The contacts list of the team
Array [
name string
Name of the contact
phone string
Phone of the contact
mobile_phone string
Mobile Phone of the contact
email string
Email of the contact
role string
Role of the contact
lang string
Language of the contact
type string
Type of the contact
]
categories object[]
Categories of Team (ref team_type)
Array [
id int64
name object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
user_id string

The user id of the creator of the team (team_type). See

name stringrequired

Official business name

active boolean

Define if the team is active or not

created_at string

Date of creation of the team

updated_at string

Date of last update of the team

gln_status string

Possible values: [active, inactive, pending, refused]

Current status of the GLN registration request in GS1

images object[]
The images list of the team (logo, etc..)
Array [
src stringrequired
URL of the image (GUI content providers will be able to upload images and have the URL set here. API content providers must mention a public image's URL.)
alt string
Alt text of the image (if available)
ratio string
Ratio of the image (e.g. 16:9, 4:3, etc...)
type string
Type of the image (e.g. logo, main, etc...)
]
gln string

GS1's producer ID, if known

company_number string

The company number of the team (might differ from VAT in some country)

vat string

The VAT number of the team

vat_exemption boolean

Define if the team is VAT exempted

main_language string

The main language of the team

other_languages object[]
The other languages of the team (iso
Array [
id string
label string
]
name_friendly string

Name towards customers. Official one used if this one is empty

website string

The website of the Organization

short_bio object

Short bio of the team

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

long_bio object

Long bio of the team

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

personal_team boolean

Define if the team is a personal team (single user organization)

distance numbernullable

Distance

farmer_sectors object[]nullable
Farming sectors (if applicable) See /api/categories?type=farmer_sector&per_page=100
Array [
id int64
name object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
role stringnullable

Role of the user in the team. If null the user is not part of the team

total_members integernullable

Total members of the team

visibility objectnullable
Define what can of categories team_type can see the team
info object
Define who can see the info of the team
limit integer
Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0
unauthorized object[]
Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.
Array [
id int64
name objectrequired
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
products object
Define who can see the products info of the team
limit integer
Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0
unauthorized object[]
Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.
Array [
id int64
name objectrequired
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
prices object
Define who can see the prices info of the team
limit integer
Maximum distance (in kilometers) a producer agrees to cover to (self) deliver this product. Predefined thresholds are 25, 40 and 80 km. “everywhere” is valued as 0
unauthorized object[]
Define which team categories (commercial segments) cannot see this product. When consulting, content gatherer will not get the product infos if their own commercial segments is in this restriction list. In addition, this restriction list is provided to help "global" content gatherers target the (producer defined) product's intended business segments through a substractive (black list) approach.
Array [
id int64
name objectrequired
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]

Example (from schema)

{
  "id": 0,
  "addresses": [
    {
      "id": "string",
      "name": "string",
      "address": "string",
      "model_type": "string",
      "model_id": "string",
      "country": "string",
      "role": "string",
      "organization": "string",
      "name_prefix": "string",
      "name_suffix": "string",
      "first_name": "string",
      "last_name": "string",
      "street": "string",
      "building_number": "string",
      "building_flat": "string",
      "city": "string",
      "city_prefix": "string",
      "city_suffix": "string",
      "state": "string",
      "state_code": "string",
      "postcode": "string",
      "lat": "string",
      "lng": "string",
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "contacts": [
    {
      "name": "string",
      "phone": "string",
      "mobile_phone": "string",
      "email": "string",
      "role": "string",
      "lang": "string",
      "type": "string"
    }
  ],
  "categories": [
    {
      "id": 0,
      "name": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "code": "string",
      "level": 0,
      "description": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "active": true,
      "slug": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "type": "string",
      "_lft": 0,
      "_rgt": 0,
      "parent_id": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "user_id": "string",
  "name": "string",
  "active": true,
  "created_at": "string",
  "updated_at": "string",
  "gln_status": "active",
  "images": [
    {
      "src": "string",
      "alt": "string",
      "ratio": "string",
      "type": "string"
    }
  ],
  "gln": "string",
  "company_number": "string",
  "vat": "string",
  "vat_exemption": true,
  "main_language": "string",
  "other_languages": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "name_friendly": "string",
  "website": "string",
  "short_bio": {
    "fr": "string",
    "nl": "string",
    "en": "string",
    "de": "string"
  },
  "long_bio": {
    "fr": "string",
    "nl": "string",
    "en": "string",
    "de": "string"
  },
  "personal_team": true,
  "distance": 0,
  "farmer_sectors": [
    {
      "id": 0,
      "name": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "code": "string",
      "level": 0,
      "description": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "active": true,
      "slug": {
        "fr": "string",
        "nl": "string",
        "en": "string",
        "de": "string"
      },
      "type": "string",
      "_lft": 0,
      "_rgt": 0,
      "parent_id": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "role": "admin|editor|viewer|null",
  "total_members": 0,
  "visibility": {
    "info": {
      "limit": 0,
      "unauthorized": [
        {
          "id": 0,
          "name": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "code": "string",
          "level": 0,
          "description": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "active": true,
          "slug": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "type": "string",
          "_lft": 0,
          "_rgt": 0,
          "parent_id": 0,
          "created_at": "string",
          "updated_at": "string"
        }
      ]
    },
    "products": {
      "limit": 0,
      "unauthorized": [
        {
          "id": 0,
          "name": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "code": "string",
          "level": 0,
          "description": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "active": true,
          "slug": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "type": "string",
          "_lft": 0,
          "_rgt": 0,
          "parent_id": 0,
          "created_at": "string",
          "updated_at": "string"
        }
      ]
    },
    "prices": {
      "limit": 0,
      "unauthorized": [
        {
          "id": 0,
          "name": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "code": "string",
          "level": 0,
          "description": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "active": true,
          "slug": {
            "fr": "string",
            "nl": "string",
            "en": "string",
            "de": "string"
          },
          "type": "string",
          "_lft": 0,
          "_rgt": 0,
          "parent_id": 0,
          "created_at": "string",
          "updated_at": "string"
        }
      ]
    }
  }
}

Loading...