Sign in

v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
team

Lists all teams

Retrieve a list of teams by providing the parameters such as, name, namespace_id, and seller_id. Use the page_token to navigate through the pages and page_size to specify the number of teams returned per page.

get/v2/teams

Query parameters

pageTokenstring

Use this token to paginate through the list of teams. Pass it in subsequent requests to continue from where the previous call left off.

pageSizestring int64

Define the number of teams to return per page. Defaults to 20 if not specified.

sortOption'SORT_OPTION_ASC' | 'SORT_OPTION_DESC'

Defines the order for sorting the response by timestamp. DEPRECATED: Use sort_options instead.

namestring

Filters the list by the specified team name.

namespaceIdstring

Filters the list by the specified namespace.

companyType'COMPANY_TYPE_RETAILER' | 'COMPANY_TYPE_MANUFACTURER'

Filters the list by the specified company type.

isMemberOnlyboolean

Filters the response to include only teams that the user is a member of.

sellerIdstring

Filters the list by the specified sellerId.

sortOptions.key'SORT_OPTION_KEY_NAME' | 'SORT_OPTION_KEY_UPDATED_AT'

Defines the key for sorting teams, enabling you to tailor team organization to your needs. You can sort by keys such as name and updated_at, and set the order to either ascending (ASC) or descending (DESC). Specify both the key and order to achieve precise sorting results.

sortOptions.order'SORT_OPTION_ORDER_ASC' | 'SORT_OPTION_ORDER_DESC'

Specifies the order in which the teams are sorted. Choose from ascending (SORT_OPTION_ORDER_ASC) or descending (SORT_OPTION_ORDER_DESC) order.

Response

A list of teams and a pagination token.

nextPageTokenstring

Token to retrieve the next page of results.

totalCountstring int64

Total count of records that exists.

Example response

{
  "teams": [
    {
      "id": "team_001XYZ",
      "name": "Development Team",
      "namespaceId": "namespace_ABC123",
      "companyName": "Innovative Solutions Ltd.",
      "companyWebsite": "https://www.innovativesolutions.com",
      "companyPhone": "+1-234-567-8901",
      "companyAddress": {
        "addressLine": "123 Main St",
        "postcode": "12345"
      },
      "logoId": "logo_567XYZ",
      "userIds": [
        "user_001",
        "user_002",
        "user_003"
      ],
      "businessIdentifier": "biz_AB12345",
      "reviewerEmail": "reviewer@innovativesolutions.com",
      "sellerId": "seller_990XYZ",
      "modifyTime": "2024-02-14T23:45:01Z",
      "onBehalfOf": "Ad Sponsor Ltd."
    }
  ]
}