Skip to main content
GET
/
organization
/
{external_id}
Get an organization by external ID
curl --request GET \
  --url https://thalamus.nerds.nl/api/v1/organization/{external_id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Partner API key (e.g. nerds_live_a8f3d9k2m5n7p1q4r6t8v0w2x4y6z8)

Path Parameters

external_id
string
required

External organization ID

Example:

"ORG-5001"

Response

Organization found

success
boolean
Example:

true

data
object
message
string