Organizations

List organizations available to the token

GET /api/v1/organizations

Parameters

Name	In	Type	Required	Description
`limit`	query	integer	No	Maximum number of items to return.
`offset`	query	integer	No	Number of items to skip.
`search`	query	string	No	Case-insensitive search across scalar fields.
`filter`	query	string	No	Server-side exact filters as comma-separated `field=value` pairs.
`sort`	query	string	No	Comma-separated sort fields. Prefix with `-` or suffix `:desc` for descending order.
`cursor`	query	string	No	Cursor returned by a previous cursor-mode list response.
`pageMode`	query	string (offset, cursor)	No	Set to `cursor` to return `{items,nextCursor,hasMore}` inside the response data.

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/organizations?limit=<limit>&offset=<offset>&search=<search>&filter=<filter>&sort=<sort>&cursor=<cursor>&pageMode=<pageMode>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Other statuses: 401, 403.

Response body type

{ data: Organization[] }

Get organization by WorkOS id

GET /api/v1/organizations/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	—

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/organizations/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "id": "string",
    "name": "string"
  }
}

Other statuses: 401, 403, 404.

Response body type

{ data: Organization }