Get User

This endpoint allows you to get the users for either the group or a specific workflow.

POST Parameters

ParameterRequiredValueDescription
api_key{key}An API key that has access to the resource you want to query for
workflow_id{integer}The ID of a specific workflow to get users for
group_id{integer}The ID of a specific group to get users for
Information Circle

User Scope: If neither workflow_id nor group_id is specified, returns users associated with the API key's group. Specify one parameter to filter users by workflow or group.

Response Information

ElementDescription
<status>A status code in response to the operation
<message>Additional information about the operation – human readable
<user>Container for user information (can appear multiple times)
<user>→<user_id>The unique ID of the user
<user>→<name>Full name of the user
<user>→<email_address>Email address of the user
<user>→<primary_group_id>The ID of the user's primary group
<user>→<assigned_workflows>Comma-separated list of workflow IDs the user is assigned to

Sample Request

POST https://api-app.xtracta.com/v1/user HTTP/1.1
api_key=123&group_id=12345

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<user_response>
    <status>200</status>
    <message>The request has been successfully processed</message>
    <user>
       <user_id>123</user_id>
       <name>John Doe</name>
       <email_address>john.doe@xtracta.com</email_address>
       <primary_group_id>3</primary_group_id>
       <assigned_workflows>496553,496941,498082,503860,504988,505283,505328,673490,694444,698730,872472,877141</assigned_workflows>
    </user>
</user_response>

Schema Definition

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

  <xs:simpleType name="ConfidenceType">
    <xs:union>
      <xs:simpleType>
        <xs:restriction base="xs:integer">
          <xs:minInclusive value="0"/>
          <xs:maxInclusive value="100"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value=""/>
        </xs:restriction>
      </xs:simpleType>
    </xs:union>
  </xs:simpleType>

  <xs:complexType name="UserresponseType">
    <xs:sequence>
      <xs:element name="status" type="xs:positiveInteger"/>
      <xs:element name="message" type="xs:string"/>
      <xs:element name="user" type="UserType" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="UserType">
    <xs:sequence>
      <xs:element name="user_id" type="xs:nonNegativeInteger"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="email_address" type="xs:string"/>
      <xs:element name="primary_group_id" type="xs:nonNegativeInteger"/>
      <xs:element name="assigned_workflows" type="xs:nonNegativeInteger" nillable="true"/>
    </xs:sequence>
  </xs:complexType>

  <xs:element name="user_response">
    <xs:complexType>
      <xs:sequence>
      <xs:element name="status" type="xs:positiveInteger"/>
      <xs:element name="message" type="xs:string"/>
      <xs:element name="user" type="UserType" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>