Skip to main content

Get Organization

Retrieves detailed information about a specific organization.
GET /v1/organizations/:id

Path Parameters

ParameterTypeRequiredDescription
idstringRequiredOrganization ID (prefix: org_)

Example Request

curl https://api.docyard.io/v1/organizations/org_01HQ3K9B2... \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

Response

{
  "id": "org_01HQ3K9B2...",
  "name": "Bank of America",
  "slug": "bank-of-america",
  "metadata": {
    "industry": "financial-services",
    "region": "north-america",
    "tier": "enterprise"
  },
  "createdAt": "2024-03-01T12:00:00.000Z",
  "updatedAt": "2024-03-01T12:00:00.000Z",
  "_count": {
    "docks": 3,
    "parties": 12,
    "machineClients": 2
  }
}

Response Fields

FieldTypeDescription
idstringUnique organization identifier
namestringOrganization display name
slugstringURL-friendly unique identifier
metadataobjectCustom JSON attributes
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp
_count.docksintegerNumber of docks in organization
_count.partiesintegerNumber of parties in organization
_count.machineClientsintegerNumber of machine clients

Error Handling

StatusCondition
401Missing or invalid API key
404Organization not found or not accessible