Docs

API reference · Organizations

org management customers list

GET/v1/orgs/{org}/management/customers
Permission
authenticated: any signed-in caller or API token
Operation
org.management.customers.list

Parameters

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
limitqueryintegerno1 to 100; default 50
cursorquerystringnofor example "mlink_01h455vb4pex5vsknk084sn02q"
x-obhut-management-assignmentheaderstringnoSelect one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q"

Response 200

FieldTypeRequiredNotes
itemsarray of objectyes
items[].customerobjectyes
items[].customer.idstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
items[].customer.namestringyes
items[].linkobjectyes
items[].link.idstringyesfor example "mlink_01h455vb4pex5vsknk084sn02q"
items[].link.customerOrgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
items[].link.providerOrgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
items[].link.offerIdstringyesfor example "moffer_01h455vb4pex5vsknk084sn02q"
items[].link.permissionsarray of stringyes1 to 100 items
items[].link.revisionstringyesOpaque revision: dot-joined counters.
items[].link.approvedBystringyesfor example "user_01h455vb4pex5vsknk084sn02q"
items[].link.approvedAtstring (date-time)yesUTC, ISO 8601.
items[].link.endedAtstring (date-time) or nullyes
items[].link.endedBystring or nullyes
items[].link.endReasonstring or nullyes
items[].link.handoverReviewobject or nullyes
items[].link.handoverReview.completedarray of stringyes0 to 5 items
items[].link.handoverReview.reviewedAtstring (date-time)yesUTC, ISO 8601.
items[].link.handoverReview.reviewedBystring or nullyes
items[].assignmentsarray of objectyes
items[].assignments[].assignmentIdstringyesfor example "masg_01h455vb4pex5vsknk084sn02q"
items[].assignments[].linkIdstringyesfor example "mlink_01h455vb4pex5vsknk084sn02q"
items[].assignments[].providerOrgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
items[].assignments[].customerOrgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
items[].assignments[].userIdstringyesfor example "user_01h455vb4pex5vsknk084sn02q"
items[].assignments[].permissionsarray of stringyes1 to 100 items
items[].assignments[].createdAtstring (date-time)yesUTC, ISO 8601.
nextCursorstring or nullyes