Skip to main content
GET
/
v1
/
organizations
List Organizations
curl --request GET \
  --url https://api.us.lexful.app/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-ID: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_primary": true,
      "name": "<string>",
      "slug": "<string>",
      "type": "<string>",
      "status": "<string>",
      "description": "<string>",
      "logo_url": "<string>",
      "website_url": "<string>",
      "notes": "<string>",
      "alert": "<string>",
      "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "asset_management": "disabled",
      "labels": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "updated_by": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Query Parameters

status
string

Filter by status

type
string

Filter by type

slug
string

Filter by slug

name
string

Filter by name (partial match)

is_primary
boolean

Filter by primary organization flag

parent_id
string<uuid>

Filter by parent organization

asset_management
enum<string>

Filter by asset management status

Available options:
disabled,
enabled,
read_only
include_deleted
boolean

Include deleted organizations

limit
number
default:100
Required range: 1 <= x <= 1000
offset
number
default:0
Required range: x >= 0
sort
string

Comma-separated fields to sort by (e.g., "name,created_at")

order
string

Comma-separated sort directions - ASC or DESC (e.g., "ASC,DESC")

expand
string

Comma-separated list of fields to expand (e.g., "labels")

labels
string

Comma-separated label IDs to filter by

Response

Default Response

items
object[]
required
total
number
required

Total number of items available

limit
number
required

Number of items returned

offset
number
required

Number of items skipped