Develop
Develop
Select your platform

Read Federated Users API

Updated: Oct 1, 2025
This topic provides reference for the API used to get data for multiple federated users created within the same developer team.

Read Users

Method:
GET
Endpoint:
https://graph.oculus.com/{federated_app_id}/federated_users

Path Parameters

The following table lists the API’s URL path parameters.
NameDescription
{federated_app_id}
The federated application ID which can be obtained from the Developer Dashboard API page.

Query Parameters

The following table lists the API’s query parameters.
NameDescriptionOptionalType
fields
A comma-separated list of the fields to include in the response.
✓
A comma-separated list.
Valid values:
• id
• persistent_id
• unique_name
• display_name
access_token
Bearer token that contains OC|$APP_ID |$APP_SECRET
 
String

Response

The following table describes the JSON payload received in the API response.
NameDescriptionOptionalType
data
An paginated array of federated users with the requested fields.
 
Array
data{id}
A federated user’s ID, unique to the developer organization it was created under.
✓
64-bit unsigned integer
data{persistent_id}
A unique immutable ID that is used for federated user indexing.
✓
String
data{unique_name}
A unique name given to a federated user if their display name is already taken by another user, formatted {display_name}# followed by a numerical ID.
✓
String
data{display_name}
A name for a federated user which can be displayed in a federated app.
✓
String
paging
An array of URLs used to paginate to the previous or the next set of users.
 
Array
paging{previous}
The URL used to paginate to the previous set of users or an empty string if there are no previous users.
 
String
paging{next}
The URL used to paginate to the next set of users or an empty string if there are no more users next.
 
String

Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta