Did You Know?

Docly turns out that context is a key part of learning.

Get Omnily
leafleafleafMan illustrationFlower illustration
Updated on May 21, 2024

User

Estimated reading: 15 minutes 31 views

GET /v1/users/

				
					https://rest.gohighlevel.com/v1/users/?locationId=i2SpAtBVHSVea1sL6oah

Get all agency users.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION Bearer Token

Token

<token>

PARAMS

locationId

i2SpAtBVHSVea1sL6oah

(Optional) Filter users by location.

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/users/?locationId=i2SpAtBVHSVea1sL6oah' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

				
					{
  "users": [
    {
      "id": "3g3ltlwEJBoXArLowV3e",
      "firstName": "John",
      "lastName": "Deo",
      "email": "john@deo.com",
      "roles": {
        "type": "agency",
        "role": "admin",
        "locationIds": [
          "C2QujeCh8ZnC7al2InWR"
        ]
      },
      "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
      }
    },
    {
      "id": "3g3ltlwEJBoXArLowV3e",
      "firstName": "John",
      "lastName": "Deo",
      "email": "john@deo.com",
      "roles": {
        "type": "agency",
        "role": "admin",
        "locationIds": [
          "C2QujeCh8ZnC7al2InWR"
        ]
      },
      "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
      }
    }
  ]
}

POST /v1/users/

				
					https://rest.gohighlevel.com/v1/users/

Create a User.

Small description for the field allow options.

type fields will allow these options:

  • account
  • agency

 

role fields will allow these options:

  • admin
  • user

 

locationIds fields will allow valid locations id of the agency.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

BODY raw (json)

				
					{
    "firstName": "John",
    "lastName": "Deo",
    "email": "john@deo.com",
    "password": "*******",
    "type": "account",
    "role": "admin",
    "locationIds": [
        "C2QujeCh8ZnC7al2InWR"
    ],
    "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
    }
}

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/users/' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "firstName": "John",
    "lastName": "Deo",
    "email": "john@deo.com",
    "password": "*******",
    "type": "account",
    "role": "admin",
    "locationIds": [
        "C2QujeCh8ZnC7al2InWR"
    ],
    "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
    }
}'

EXAMPLE RESPONSE (json)

				
					{
  "users": [
    {
      "id": "3g3ltlwEJBoXArLowV3e",
      "firstName": "John",
      "lastName": "Deo",
      "email": "john@deo.com",
      "roles": {
        "type": "agency",
        "role": "admin",
        "locationIds": [
          "C2QujeCh8ZnC7al2InWR"
        ]
      },
      "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
      }
    },
    {
      "id": "3g3ltlwEJBoXArLowV3e",
      "firstName": "John",
      "lastName": "Deo",
      "email": "john@deo.com",
      "roles": {
        "type": "agency",
        "role": "admin",
        "locationIds": [
          "C2QujeCh8ZnC7al2InWR"
        ]
      },
      "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
      }
    }
  ]
}

GET /v1/users/location

				
					https://rest.gohighlevel.com/v1/users/location

AUTHORIZATION Bearer Token

Get user by location.

Authorization:

Provide your location api key (Bearer Token). You can find here

Token

<token>

EXAMPLE REQUEST (curl)
				
					curl --location 'https://rest.gohighlevel.com/v1/users/location' \
--header 'Authorization: Bearer <token>'
EXAMPLE RESPONSE (json)
				
					{
  "users": [
    {
      "id": "3g3ltlwEJBoXArLowV3e",
      "firstName": "John",
      "lastName": "Deo",
      "email": "john@deo.com",
      "roles": {
        "type": "agency",
        "role": "admin",
        "locationIds": [
          "C2QujeCh8ZnC7al2InWR"
        ]
      },
      "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
      }
    },
    {
      "id": "3g3ltlwEJBoXArLowV3e",
      "firstName": "John",
      "lastName": "Deo",
      "email": "john@deo.com",
      "roles": {
        "type": "agency",
        "role": "admin",
        "locationIds": [
          "C2QujeCh8ZnC7al2InWR"
        ]
      },
      "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
      }
    }
  ]
}

GET /v1/users/lookup

				
					https://rest.gohighlevel.com/v1/users/lookup?email=hello@google.com

Find user by email.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION Bearer Token

Token

<token>

PARAMS

email

hello@google.com

(Required) Email

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/users/lookup?email=hello%40google.com' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

				
					{
  "id": "3g3ltlwEJBoXArLowV3e",
  "firstName": "John",
  "lastName": "Deo",
  "email": "john@deo.com",
  "roles": {
    "type": "agency",
    "role": "admin",
    "locationIds": [
      "C2QujeCh8ZnC7al2InWR"
    ]
  },
  "permissions": {
    "campaignsEnabled": true,
    "campaignsReadOnly": false,
    "contactsEnabled": true,
    "workflowsEnabled": true,
    "triggersEnabled": true,
    "funnelsEnabled": true,
    "websitesEnabled": false,
    "opportunitiesEnabled": true,
    "dashboardStatsEnabled": true,
    "bulkRequestsEnabled": true,
    "appointmentsEnabled": true,
    "reviewsEnabled": true,
    "onlineListingsEnabled": true,
    "phoneCallEnabled": true,
    "conversationsEnabled": true,
    "assignedDataOnly": false,
    "adwordsReportingEnabled": false,
    "membershipEnabled": false,
    "facebookAdsReportingEnabled": false,
    "attributionsReportingEnabled": false,
    "settingsEnabled": true,
    "tagsEnabled": true,
    "leadValueEnabled": true,
    "marketingEnabled": true
  }
}

GET /v1/users/:userId

				
					https://rest.gohighlevel.com/v1/users/:userId

Get agency by user id.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

userId

082goXVW3lIExEQPOnd3

(Required) User Id

EXAMPLE REQUEST (curl)

				
					curl --location 'https://rest.gohighlevel.com/v1/users/082goXVW3lIExEQPOnd3' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

				
					{
  "id": "3g3ltlwEJBoXArLowV3e",
  "firstName": "John",
  "lastName": "Deo",
  "email": "john@deo.com",
  "roles": {
    "type": "agency",
    "role": "admin",
    "locationIds": [
      "C2QujeCh8ZnC7al2InWR"
    ]
  },
  "permissions": {
    "campaignsEnabled": true,
    "campaignsReadOnly": false,
    "contactsEnabled": true,
    "workflowsEnabled": true,
    "triggersEnabled": true,
    "funnelsEnabled": true,
    "websitesEnabled": false,
    "opportunitiesEnabled": true,
    "dashboardStatsEnabled": true,
    "bulkRequestsEnabled": true,
    "appointmentsEnabled": true,
    "reviewsEnabled": true,
    "onlineListingsEnabled": true,
    "phoneCallEnabled": true,
    "conversationsEnabled": true,
    "assignedDataOnly": false,
    "adwordsReportingEnabled": false,
    "membershipEnabled": false,
    "facebookAdsReportingEnabled": false,
    "attributionsReportingEnabled": false,
    "settingsEnabled": true,
    "tagsEnabled": true,
    "leadValueEnabled": true,
    "marketingEnabled": true
  }
}

PUT /v1/users/:userId

				
					https://rest.gohighlevel.com/v1/users/:userId

Update a User.

Small description for the field allow options.

type fields will allow these options:

  • account
  • agency

 

role fields will allow these options:

  • admin
  • user

 

locationIds fields will allow valid locations id of the agency.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION Bearer Token

PUT /v1/users/:userId

				
					https://rest.gohighlevel.com/v1/users/:userId

Update a User.

Small description for the field allow options.

type fields will allow these options:

  • account
  • agency

 

role fields will allow these options:

  • admin
  • user

 

locationIds fields will allow valid locations id of the agency.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

userId

082goXVW3lIExEQPOnd3

(Required) User Id

BODY raw (json)

				
					{
    "firstName": "John",
    "lastName": "Deo",
    "email": "john@deo.com",
    "password": "*******",
    "type": "account",
    "role": "admin",
    "locationIds": [
        "C2QujeCh8ZnC7al2InWR"
    ],
    "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
    }
}

EXAMPLE REQUEST (curl)

				
					curl --location --request PUT 'https://rest.gohighlevel.com/v1/users/082goXVW3lIExEQPOnd3' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "firstName": "John",
    "lastName": "Deo",
    "email": "john@deo.com",
    "password": "*******",
    "type": "account",
    "role": "admin",
    "locationIds": [
        "C2QujeCh8ZnC7al2InWR"
    ],
    "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "contactsEnabled": true,
        "workflowsEnabled": true,
        "triggersEnabled": true,
        "funnelsEnabled": true,
        "websitesEnabled": false,
        "opportunitiesEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "adwordsReportingEnabled": false,
        "membershipEnabled": false,
        "facebookAdsReportingEnabled": false,
        "attributionsReportingEnabled": false,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "marketingEnabled": true
    }
}'

EXAMPLE RESPONSE (json)

				
					{
  "id": "3g3ltlwEJBoXArLowV3e",
  "firstName": "John",
  "lastName": "Deo",
  "email": "john@deo.com",
  "roles": {
    "type": "agency",
    "role": "admin",
    "locationIds": [
      "C2QujeCh8ZnC7al2InWR"
    ]
  },
  "permissions": {
    "campaignsEnabled": true,
    "campaignsReadOnly": false,
    "contactsEnabled": true,
    "workflowsEnabled": true,
    "triggersEnabled": true,
    "funnelsEnabled": true,
    "websitesEnabled": false,
    "opportunitiesEnabled": true,
    "dashboardStatsEnabled": true,
    "bulkRequestsEnabled": true,
    "appointmentsEnabled": true,
    "reviewsEnabled": true,
    "onlineListingsEnabled": true,
    "phoneCallEnabled": true,
    "conversationsEnabled": true,
    "assignedDataOnly": false,
    "adwordsReportingEnabled": false,
    "membershipEnabled": false,
    "facebookAdsReportingEnabled": false,
    "attributionsReportingEnabled": false,
    "settingsEnabled": true,
    "tagsEnabled": true,
    "leadValueEnabled": true,
    "marketingEnabled": true
  }
}

DELETE /v1/users/:userId

				
					https://rest.gohighlevel.com/v1/users/:userId

Delete one of user.Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

userId

082goXVW3lIExEQPOnd3

(Required) User Id

EXAMPLE REQUEST (curl)

				
					curl --location --request DELETE 'https://rest.gohighlevel.com/v1/users/082goXVW3lIExEQPOnd3' \
--header 'Authorization: Bearer <token>'

EXAMPLE RESPONSE (json)

				
					""

Leave a Comment

Share this Doc

User

Or copy link

CONTENTS

Powered By EazyDocs