Get Accesses
The allAccesses query returns all Access configurations available in your organization.
An access is the set of credentials and technical settings that lets a Buyer connect to a Seller in HotelX.
Use this endpoint when you need to:
- Build an internal catalog of usable accesses
- Validate if an access is active before executing Search/Quote/Book
- Identify which supplier and credentials are currently configured
Query Overviewβ
Path: admin/get-accesses/
GraphQL root:
admin {
allAccesses {
edges {
node {
accessData {
...
}
}
}
}
}
The response is a connection, so you can read:
edges: list of accessestotalCount: total number of accesses in your organization
Simple Accesses Requestβ
Use this version when you only need a lightweight inventory of configured accesses.
Returned fields:
nameisActivecode
Advanced Accesses Requestβ
Use this version when you need integration-level details (credentials, supplier metadata, URLs and runtime parameters).
Returned fields:
nameisActivecodesupplierisTestuserpassword(To retrieve this field, ADMIN permissions are required. Otherwise, the value will be null.)urlsparameters
Field Descriptionsβ
The following fields are returned in the accessData object:
| Field | Description |
|---|---|
name | The name of the access configuration. |
isActive | Indicates whether the access is currently active. |
code | A unique code identifying the access configuration. |
supplier | The supplier associated with the access. |
isTest | Specifies if the access is for testing purposes. |
user | The username used for authentication. |
password | The password for authentication (requires ADMIN permissions to retrieve). |
urls | The URLs associated with the access configuration. |
parameters | Additional runtime parameters for the access configuration. |
This table complements the "Returned fields" lists provided earlier by offering detailed descriptions for each field.
Common Use Casesβ
- Validate Access Configurations: Ensure that all access configurations are active and correctly set up.
- Build Access Catalogs: Create an internal catalog of all available accesses for operational monitoring.
- Identify Supplier Credentials: Retrieve supplier-specific credentials and information for integration purposes.
Query Exampleβ
Simple Requestβ
This example retrieves a list of all accesses with their basic details.
query {
admin {
allAccesses {
edges {
node {
name
isActive
code
}
}
}
}
}
Variables Exampleβ
This query does not require variables.
{}
Response Exampleβ
Here is an example of the response:
{
"data": {
"admin": {
"allAccesses": {
"edges": [
{
"node": {
"name": "Access A",
"isActive": true,
"code": "11123"
}
},
{
"node": {
"name": "Access B",
"isActive": false,
"code": "444456"
}
}
]
}
}
}
}
Response Considerationsβ
passwordrequires ADMIN permissions. Without those permissions, it is returned asnull.supplierhelps you map each access to a specific Seller andcontext.parametersmay vary by Seller integration.