Read Member by External ID
Intent
Reads the member by external id without changing it.
When to call it
Call this after your application has received or stored the identifier for the member by external id.
Access boundary
Authorize the request with a token that carries members:read or members:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
Get a member by external ID. One of customer_id or external_customer_id must be specified.
Scopes: members:read members:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The member external ID.
Query Parameters
The customer ID.
The customer external ID.
Response
Member retrieved.
A member of a customer.
The ID of the member.
The time Ruba created this record.
The time this record last changed.
The ID of the customer this member belongs to.
The email address of the member.
"member@example.com"
The name of the member.
"Jane Doe"
The ID of the member in your system. This must be unique within the customer.
"usr_1337"
The role of the member within the customer.
owner, billing_manager, member "owner"