Keyspace API Docs
GuidesReferenceOpenAPIAI agents
OpenAPI referencePartner members

Read one of your members — profile, status and credential summary

GET
/partner/members/{externalUserId}

Never returns face bytes (presence only). Unknown or foreign external ids are 403 KS221; a GET never creates a member.

Authorization

bearerAuth
AuthorizationBearer <token>

Access token from POST /auth/accessToken

In: header

Path Parameters

externalUserId*string

YOUR stable identifier for the user (opaque to Keyspace). Bound to exactly one Keyspace member per app on first PUT.

Lengthlength <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/partner/members/string"
{  "code": "KS000",  "success": true,  "message": "string",  "data": {    "memberId": "string",    "externalUserId": "string",    "projectId": "string",    "status": "active",    "source": "partner",    "userType": "member",    "accessGroupIds": [      "string"    ],    "employeeId": "string",    "unit": {      "roomId": "string",      "addressNo": "string",      "groupId": "string",      "role": "owner"    },    "profile": {      "firstName": "string",      "lastName": "string",      "profileName": "string",      "email": "string",      "phone": "string"    },    "credentials": {      "cards": [        {          "cardId": "string",          "cardNo": "string",          "label": "string",          "type": "real",          "generated": true        }      ],      "face": {        "present": true      }    }  }}

Check out of a booking (ends it — irreversible) POST

Only checked-in bookings. Releases the room. Cannot be undone.

Offboard one of your members DELETE

Deactivates the member in the project: every card (physical AND the auto-generated one) is revoked, device access is withdrawn, and the member is removed from your access groups. The link between your externalUserId and the member is KEPT, so a later PUT re-activates the same member rather than creating a duplicate. Idempotent.