(v1) Get Profile Data

Returns profile form data for specified users. formNames is required and must contain at least one entry.

Note: userIds is optional. Omitting it, or supplying an empty array, does not cause the request to fail — it returns a successful response containing no profile data. Users who have no submission for a requested profile form are likewise omitted from the response rather than causing a failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required
Allowed:
string
enum
required
Allowed:
Body Params
formNames
array of strings
required

List of profile form names to return data for. Names must match exactly as they appear in AMS. Required — must contain at least one form name.

formNames*
userIds
array of integers

List of user IDs to return profile data for. Optional — if omitted or empty, the request still succeeds but no profile data is returned.

userIds
Headers
string

A unique identifier for your application. Helps Teamworks support staff identify your requests if you need assistance.

Response
200

Profile data for the specified users and forms. Returns an empty object if userIds is omitted or empty, or if none of the specified users have a submission for the requested form(s).

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!