Glue API: Retrieve company users

Last updated:
Edit on GitHub

This endpoint allows retrieving information about company users.

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see Glue API: Company Account feature integration.

Retrieve company users

To retrieve all the company users that belong to the company of the authenticated company user, send the request:

GET/company-users

Request

HEADER KEY REQUIRED DESCRIPTION
Authorization ✓ Alphanumeric string that authorizes the company user to send requests to protected resources. Get it by authenticating as a company user.

Request sample: retrieve company users

GET https://glue.mysprykershop.com/company-users

Response

Response sample: retrieve company users 
{
    "data": [
        {
            "type": "company-users",
            "id": "3692d238-acb3-5b7e-8d24-8dab9c1f4505",
            "attributes": {
                "isActive": true,
                "isDefault": false
            },
            "links": {
                "self": "https://glue.mysprykershop.com/company-users/3692d238-acb3-5b7e-8d24-8dab9c1f4505"
            }
        },
        {
            "type": "company-users",
            "id": "4c677a6b-2f65-5645-9bf8-0ef3532bead1",
            "attributes": {
                "isActive": true,
                "isDefault": false
            },
            "links": {
                "self": "https://glue.mysprykershop.com/company-users/4c677a6b-2f65-5645-9bf8-0ef3532bead1"
            }
        },
        {
            "type": "company-users",
            "id": "cfbe2644-a9bd-581b-977b-e72d1c9a9c54",
            "attributes": {
                "isActive": true,
                "isDefault": false
            },
            "links": {
                "self": "https://glue.mysprykershop.com/company-users/cfbe2644-a9bd-581b-977b-e72d1c9a9c54"
            }
        },
        {
            "type": "company-users",
            "id": "e1019900-88c4-5582-af83-2c1ea8775ac5",
            "attributes": {
                "isActive": true,
                "isDefault": false
            },
            "links": {
                "self": "https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/company-users"
    }
}
ATTRIBUTE TYPE DESCRIPTION
isActive Boolean Defines if the company user is active.
isDefault Boolean Defines if the company user is default for the authenticated company user.

Retrieve a company user

To retrieve information about a company user, send the request:

GET /company-users/{{company_user_id}}

PATH PARAMETER DESCRIPTION
{{company_user_id}} Unique identifier of a company user to retrieve information for. To get it, retrieve company users. Enter mine to retrieve information on the company user available to the current authenticated company user.

Request

HEADER KEY REQUIRED DESCRIPTION
Authorization ✓ Alphanumeric string that authorizes the company user to send requests to protected resources. Get it by authenticating as a company user.
QUERY PARAMETER DESCRIPTION POSSIBLE VALUES
Include Adds resource relationships to the request. companies, company-business-units, company-roles
REQUEST USAGE
GET https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5 Retrieve the company user with unique identifier e1019900-88c4-5582-af83-2c1ea8775ac5.
GET https://glue.mysprykershop.com/company-users/min?include=companies,company-business-units,company-roles Retrieve company users and related companies, business units, and roles.

Response

Response sample: retrieve a company user with the unique identifier 
{
    "data": {
        "type": "company-users",
        "id": "e1019900-88c4-5582-af83-2c1ea8775ac5",
        "attributes": {
            "isActive": true,
            "isDefault": false
        },
        "links": {
            "self": "https://glue.mysprykershop.com/company-users/e1019900-88c4-5582-af83-2c1ea8775ac5"
        }
    }
}
Response sample: Retrieve company users and related companies, business units, and roles 
{
    "data": [
        {
            "type": "company-users",
            "id": "4c677a6b-2f65-5645-9bf8-0ef3532bead1",
            "attributes": {...},
            "links": {...},
            "relationships": {
                "companies": {
                    "data": [
                        {
                            "type": "companies",
                            "id": "88efe8fb-98bd-5423-a041-a8f866c0f913"
                        }
                    ]
                },
                "company-business-units": {
                    "data": [
                        {
                            "type": "company-business-units",
                            "id": "b2ea10b2-263a-5cd9-88dc-747309f0534a"
                        }
                    ]
                },
                "company-roles": {
                    "data": [
                        {
                            "type": "company-roles",
                            "id": "50c647a4-d27f-5d82-a587-1d0b7cc6b58d"
                        }
                    ]
                }
            }
        },
        {
            "type": "company-users",
            "id": "cfbe2644-a9bd-581b-977b-e72d1c9a9c54",
            "attributes": {
                "isActive": true,
                "isDefault": false
            },
            "links": {
                "self": "https://glue.mysprykershop.com/company-users/cfbe2644-a9bd-581b-977b-e72d1c9a9c54?include=companies,company-business-units"
            },
            "relationships": {
                "companies": {
                    "data": [
                        {
                            "type": "companies",
                            "id": "88efe8fb-98bd-5423-a041-a8f866c0f913"
                        }
                    ]
                },
                "company-business-units": {
                    "data": [
                        {
                            "type": "company-business-units",
                            "id": "35752ce6-e25f-5d04-8bef-d46b2c359695"
                        }
                    ]
                }
            }
        },
        {
            "type": "company-users",
            "id": "e1019900-88c4-5582-af83-2c1ea8775ac5",
            "attributes": {...},
            "links": {...},
            "relationships": {
                "companies": {
                    "data": [
                        {
                            "type": "companies",
                            "id": "88efe8fb-98bd-5423-a041-a8f866c0f913"
                        }
                    ]
                },
                "company-business-units": {
                    "data": [
                        {
                            "type": "company-business-units",
                            "id": "5a6032dc-fbce-5d0d-9d57-11ade1947bac"
                        }
                    ]
                }
            }
        }
    ],
    "links": {...},
    "included": [
        {
            "type": "companies",
            "id": "88efe8fb-98bd-5423-a041-a8f866c0f913",
            "attributes": {
                "isActive": true,
                "name": "BoB-Hotel Mitte",
                "status": "approved"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/companies/88efe8fb-98bd-5423-a041-a8f866c0f913"
            }
        },
        {
            "type": "company-business-units",
            "id": "b2ea10b2-263a-5cd9-88dc-747309f0534a",
            "attributes": {
                "name": "Hotel Mitte",
                "email": "Hotel.Mitte@spryker.com",
                "phone": "12345617",
                "externalUrl": "",
                "bic": "",
                "iban": "",
                "defaultBillingAddress": null
            },
            "links": {
                "self": "https://glue.mysprykershop.com/b2ea10b2-263a-5cd9-88dc-747309f0534a"
            }
        },
        {
            "type": "company-business-units",
            "id": "35752ce6-e25f-5d04-8bef-d46b2c359695",
            "attributes": {
                "name": "Service Mitte",
                "email": "Service.Mitte@spryker.com",
                "phone": "12345617",
                "externalUrl": "",
                "bic": "",
                "iban": "",
                "defaultBillingAddress": null
            },
            "links": {
                "self": "https://glue.mysprykershop.com/company-business-units/35752ce6-e25f-5d04-8bef-d46b2c359695"
            }
        },
        {
            "type": "company-business-units",
            "id": "5a6032dc-fbce-5d0d-9d57-11ade1947bac",
            "attributes": {
                "name": "Cleaning Mitte",
                "email": "Cleaning.Mitte@spryker.com",
                "phone": "12345617",
                "externalUrl": "",
                "bic": "",
                "iban": "",
                "defaultBillingAddress": null
            },
            "links": {
                "self": "https://glue.mysprykershop.com/company-business-units/5a6032dc-fbce-5d0d-9d57-11ade1947bac"
            }
        },
        {
            "type": "company-roles",
            "id": "50c647a4-d27f-5d82-a587-1d0b7cc6b58d",
            "attributes": {
                "name": "Buyer",
                "isDefault": true
            },
            "links": {
                "self": "https://glue.mysprykershop.com/company-roles/50c647a4-d27f-5d82-a587-1d0b7cc6b58d"
            }
        }
    ]
}
ATTRIBUTE TYPE DESCRIPTION
isActive Boolean Defines if the company user is active.
isDefault Boolean Defines if the company user is default for the authenticated company user.
INCLUDED RESOURCE ATTRIBUTE TYPE DESCRIPTION
companies name String Specifies the name of the company.
companies isActive Boolean Indicates whether the company is active.
companies status String Specifies the status of the company. Possible values: Pending, Approved or Denied.
company-roles name String Specifies the name of the company role.
company-roles isDefault Boolean Indicates whether the company role is the default role for the company.
company-business-units name String Specifies the name of the business unit.
company-business-units email String Specifies the email address of the business unit.
company-business-units phone String Specifies the telephone number of the business unit.
company-business-units externalUrl String Specifies the url of the website of the business unit.
company-business-units bic String Specifies the bank identifier code of the business unit.
company-business-units iban String Specifies the International bank account number of the business unit.
company-business-units defaultBillingAddress String Specifies the default billing address of the business unit.

Possible errors

CODE REASON
001 Access token is invalid.
002 Access token is missing.
1401 Rest user is not a company user.
1403 Current company account is not set. Select the current company user with /company-user-access-tokens to access the resource collection.
1404 Specified company user is not found or does not have permissions to view the account.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.

Next steps