GET
/
v1
/
organizations
List Organizations
curl --request GET \
  --url http://127.0.0.1:3000/v1/organizations \
  --header 'Content-Type: <content-type>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "legalName": "<string>",
      "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "doingBusinessAs": "<string>",
      "legalDocument": "<string>",
      "status": {
        "status": {
          "description": "<string>",
          "code": "<string>"
        }
      },
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "zipCode": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "limit": 123
}
TipIf an organization has been deleted, its information will still be displayed — including the deletion date in the deletedAt field.

Headers

​
Content-Type
string
required

The type of media of the resource. Must be <code>application/json</code>.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Query Parameters

​
limit
string
required

The maximum number of items to include in the response. Max: 100

​
start_date
string

The beginning of the period you want to retrieve. You must also include the end_date.

​
end_date
string

The end of the period you want to retrieve. You must also include the start_date.

​
sort_order
string

The order used to sort the results.

​
page
string
required

The number of the page that you want to retrieve.

​
metadata.key
string

Any Metadata the entity should have.

Response

Indicates that the request was successful and the response contains the expected data.

​
items
object[]
​
page
integer

The number of pages returned.

​
limit
integer

The maximum number of items included in the response.