{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"members","kind":"endpoint","group":"orgs","title":"Read organisation members by page","method":"GET","path":"/v1/organizations/{n}/members","paths":[],"summary":"Read the members whose position starts with a prefix, with the proof to the members root.","response":"items are the members of the page; proof leads from the page’s subtree to root, the members root of the current version.","parameters":[{"name":"n","description":"Permanent positive card number.","in":"path","required":true},{"name":"prefix","description":"Standard base64 of the prefix bytes; empty for the first page.","in":"query","required":false},{"name":"bits","description":"Prefix length in bits, 0 to 24. Default: the server’s page depth.","in":"query","required":false}],"sample":"/v1/organizations/2/members","access":"public","base":"directory","notes":["Only on a log in format 2 (GET /v1/log says format 2). A log in format 1 answers 400 wrong_format."],"errors":["400 invalid_parameter","400 wrong_format","401 invalid_api_key","403 api_key_scope","403 api_key_suspended","403 developer_suspended","404 not_found","410 erased","422 not_an_organization","429 rate_limited","500 internal_error","503 busy"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS 'https://veil.rip/v1/organizations/2/members'"},{"kind":"code","language":"javascript","code":"const response = await fetch(\"https://veil.rip/v1/organizations/2/members\");\nconst result = await response.json();"}],"verify":"Compute the page’s subtree root from items and fold proof to root, which the card’s state.roots.members must equal.","live":false,"responses":[{"status":200,"contentType":"application/json","description":"items are the members of the page; proof leads from the page’s subtree to root, the members root of the current version.","fields":[{"name":"n","type":"integer","description":"Permanent card number."},{"name":"version","type":"integer","description":"The current version the page belongs to."},{"name":"root","type":"string","description":"The members root in standard base64."},{"name":"prefix","type":"string","description":"The prefix bytes in standard base64."},{"name":"bits","type":"integer","description":"The prefix length in bits."},{"name":"items","type":"array<object>","description":"member, role and since of each member of the page."},{"name":"proof","type":"object","description":"bitmap and siblings from height 256 minus bits to the root."},{"name":"pages","type":"integer","description":"How many pages the server’s depth makes."}]}],"responseObjects":[],"errorFormat":"json","errorDetails":[{"status":400,"code":"invalid_parameter","description":"A path, query or body field is missing, malformed or outside its accepted range.","action":"Correct the field named in `error.message` before sending again.","scope":"endpoint"},{"status":400,"code":"wrong_format","description":"The request or the read belongs to the other log format than this server’s: a v1 record on a format 2 log, or a format 2 read on a format 1 log.","action":"Read `format` in GET /v1/log (absent means 1) and send the shape of that format.","scope":"endpoint"},{"status":401,"code":"invalid_api_key","description":"The bearer credential is malformed, unknown, expired or revoked.","action":"Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.","scope":"optional-api-key"},{"status":403,"code":"api_key_scope","description":"The API key lacks read or verify scope, or the endpoint does not accept bearer keys.","action":"Use the correct scope. Identity writes and key management still require a device signature.","scope":"optional-api-key"},{"status":403,"code":"api_key_suspended","description":"This API key is suspended.","action":"Ask staff to restore it; another key cannot lift an account suspension.","scope":"optional-api-key"},{"status":403,"code":"developer_suspended","description":"The owner’s API account is suspended or the owner card is unavailable.","action":"Check the owner account and any staff restriction. Creating another key does not bypass suspension.","scope":"optional-api-key"},{"status":404,"code":"not_found","description":"The requested card, key, alias, code or resource was not found.","action":"Check the identifier. Temporary codes and previews may already have expired or been used.","scope":"endpoint"},{"status":410,"code":"erased","description":"The card existed and was erased or removed. The response also carries its public erasure receipt.","action":"Stop using this card as current authority. Retain only the public receipt if needed.","scope":"endpoint"},{"status":422,"code":"not_an_organization","description":"The card is a person where an organisation is required.","action":"Use the person endpoint or an organisation card.","scope":"endpoint"},{"status":429,"code":"rate_limited","description":"An anonymous, signed-request or API-key allowance was exceeded.","action":"Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.","scope":"common"},{"status":500,"code":"internal_error","description":"An unexpected server error occurred. Internal details are not returned.","action":"Retry reads with bounded backoff. Check write results before sending a new signed operation.","scope":"common"},{"status":503,"code":"busy","description":"The application has reached a temporary concurrency or database limit.","action":"Wait `Retry-After` seconds and retry with bounded backoff.","scope":"common"}],"responseHeaders":[{"name":"Content-Type","value":"application/json","description":"Use the declared media type before choosing a parser."},{"name":"Date","value":"HTTP date","description":"Server time. Compare it with your clock when signing requests."},{"name":"Retry-After","value":"integer seconds, on rate_limited or busy","description":"Wait at least this long before retrying. Other 429/503 codes do not necessarily include it."}],"documentationUrl":"https://veil.rip/docs/members","supportsBrowserFetch":true,"browserMode":"fetch"}}