curl --request GET \
    --url https://api.buster.so/api/v1/users/buster_bluth?is_external_id=true \
    --header 'api-key: <YOUR-API-KEY>' \
{
	"id": "eb69f89a-0590-46c0-95ce-4039c347c93a",
	"name": "Buster Bluth",
	"role": "external",
	"use_case": null,
	"email": null,
	"image": null,
	"metadata": {
		"access_variables": {
			"id": "778feab4-ef36-4283-9313-3d286836a4ca",
			"team_id": "75229e3b-35b4-4f39-9aba-3ab44d2ea3ff",
			"role": "admin"
		}
	},
	"onboarding": {
		"project_onboarding": false,
		"finetune_onboarding": false
	},
	"external_group": "Bluth Banana Stand",
	"external_id": "buster_bluth",
	"created_at": "2023-12-11T19:43:44.425792Z",
	"updated_at": "2023-12-11T19:43:44.425847Z",
	"deleted_at": null
}

The external_id field is the identifier that you assigned to your user at creation.

Path parameters

id
string
required

This references the unique identifier for the user. This can either be the id of the user or the external_id that you assigned at user creation.

Query parameters

is_external_id
boolean

When set to true, the id field will be treated as an external_id. Default is false.

  curl --request GET \
    --url https://api.buster.so/api/v1/users/buster_bluth?is_external_id=true \
    --header 'api-key: <YOUR-API-KEY>' \
{
	"id": "eb69f89a-0590-46c0-95ce-4039c347c93a",
	"name": "Buster Bluth",
	"role": "external",
	"use_case": null,
	"email": null,
	"image": null,
	"metadata": {
		"access_variables": {
			"id": "778feab4-ef36-4283-9313-3d286836a4ca",
			"team_id": "75229e3b-35b4-4f39-9aba-3ab44d2ea3ff",
			"role": "admin"
		}
	},
	"onboarding": {
		"project_onboarding": false,
		"finetune_onboarding": false
	},
	"external_group": "Bluth Banana Stand",
	"external_id": "buster_bluth",
	"created_at": "2023-12-11T19:43:44.425792Z",
	"updated_at": "2023-12-11T19:43:44.425847Z",
	"deleted_at": null
}