Get an element

GET/ui_identifiers/{element_id}

Base URL https://app.testsigma.com/api/v1Region

Retrieve a single element by its ID, including its locator type, locator value, and screen name.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Path parameters

element_id The ID of the element to retrieve.

Response attributes

`id`	Unique element identifier.
`name`	Name of the element.
`locatorType`	Locator strategy — xpath, css_selector, id, name, classname, linktext, tagname.
`definition`	The locator expression used to find the element.
`status`	Review status — READY or DRAFT.
`screenNameId`	ID of the screen the element belongs to.
`applicationVersionId`	ID of the application version.
`createdType`	How the element was created — CHROME, ADVANCED, or MANUAL.

Request

curl -X GET \
  'https://app.testsigma.com/api/v1/ui_identifiers/{element_id}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'

const response = await fetch('https://app.testsigma.com/api/v1/ui_identifiers/{element_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
  'https://app.testsigma.com/api/v1/ui_identifiers/{element_id}',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

Response200 OK

{
  "id": 101,
  "name": "Login Button",
  "locatorType": "xpath",
  "definition": "//button[@id='login-btn']",
  "status": "READY",
  "screenNameId": 12,
  "applicationVersionId": 39,
  "createdType": "CHROME",
  "createdById": 9
}

Was this page helpful?