Integration
API Reference

Lists all teams

get
https://auth.<env>.citrusad.com/v2/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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

string

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

string
enum
Defaults to SORT_OPTION_DESC

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

Allowed:
string

Filters the list by the specified team name.

string

Filters the list by the specified namespace.

string
enum

Filters the list by the specified company type.

Allowed:
boolean

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

string

Filters the list by the specified sellerId.

string
enum

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.

Allowed:
string
enum
Defaults to 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.

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago