Lookup

Endpoints for resolving slugs to PMS-specific identifiers and vice versa

Lookup Slug

Fetches the pms specific id of a given organisation or practice in slipstream

Securityazure_auth

Request

Slug

required

string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The slug of a practice site or organisation

Example: s8n6EzC

Responses

200

The details of the entity represented by the slug

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

5XX

Server Error (ProblemDetails)

get/lookup/slug/{Slug}

Request samples

Response samples

application/json

{"Slug": "s8n6EzC",
"PmsSpecificId": "UKLUM123",
"EntityType": "Site",
"PracticeManagementSoftware": "Unknown"
}