API reference/Workmate Workforce
GETstatefullegacy-source evidence

To get all your client details

/clients

Get all your client details that comes under your organization. Using this API you will be able to identify the client's unique id, name, address,lat, long, and the contact person details. Also, you can get client's department details belong to the client.

Legacy contract evidence

This operation was normalized from a MapmyIndia-generation specification. Validate its current Mappls host, path, package entitlement, authentication generation, and commercial availability before production use.

Call the operation

GEThttps://workmate.mapmyindia.com/apis/clients
Base URLhttps://workmate.mapmyindia.com/apis/
Authenticationoauth2 bearer
Journey roleobserve
Content typesNo request body

Parameters

NameLocationTypeDescriptionExample
apiVersionrequired
headerstring

API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0

v1.0.0
startTime
queryinteger

EPOCH time stamp in local time. Records will be fetched from this start time.

1700000000000
endTime
queryinteger

EPOCH time stamp in local time. Records will be fetched till this end time.

1700000000000
userId
queryinteger

Unique ID of the user. Once it is mentioned, only client created by these user will be displayed.

332,4323
clientId
queryinteger

Unique ID of the client. To get the details about only the mentioned client.

YOUR_CLIENT_ID

Build your request in eight languages

Change source-backed examples once, validate required inputs, and copy the synchronized cURL, JavaScript, Python, Java, C#, Go, PHP, or Ruby request. Credentials remain environment references, and this page never sends a provider request.

Local request composerCode stays local · fixtures are explicit
GETRequest inputs
5 editable · 0 protected
Generated in eight languages
Environment-backed credentials
GEThttps://workmate.mapmyindia.com/apis/clients?startTime=1700000000000&endTime=1700000000000&userId=332%2C4323&clientId=YOUR_CLIENT_ID
Credential-free sandboxExecute this contract without a provider call
How fixtures work
Generated from your inputs
curl --request GET \
  --url 'https://workmate.mapmyindia.com/apis/clients?startTime=1700000000000&endTime=1700000000000&userId=332%2C4323&clientId=YOUR_CLIENT_ID' \
  --header "Accept: application/json" \
  --header "Authorization: Bearer ${MAPPLS_ACCESS_TOKEN}"

Credential-safe by constructionSet MAPPLS_ACCESS_TOKEN only in your trusted runtime. Code generation stays local. Sandbox execution sends only bounded fixture inputs to this developer platform and never reads a credential or calls Mappls.

Send a production-shaped request

Examples use environment-backed access tokens, explicit timeouts where supported, status checks, and JSON bodies derived from the source schema. Replace sample identifiers and coordinates with values from your application.

GET /clients
curl --request GET \
  --url 'https://workmate.mapmyindia.com/apis/clients' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Responses

200

successful API call

204

Content not available for the selected period.

400

Bad Request - Invalid ID supplied or invalid data type.

401

Unauthorized Request. Access to API is forbidden.

403

User type is Field user. Only manager and admin type user have the access to this API

404

Not Found - URL Not Found

406

userId not belong to your account

200 response fields

FieldTypeDescriptionExample
clients
array<object>

No field description in the source contract.

example
clients[].id
integer

Unique ID of the client or Customer

3232
clients[].status
integer

Client status. 1 - active, 0 - inactive

1
clients[].name
string

Name of the client or customer

ABN pvt.ltd
clients[].address
string

Location address of the client or customer.

237, okhla phase 3, new delhi -110020
clients[].contactPersonName
string

Contact person name of client or customer location

Dinesh
clients[].emailId
string

Client or Customer contact email id.

workmate@mapmyindia.com
clients[].mobileNo
string

Client or Customer contact mobile number

9348332321
clients[].userId
integer

The Id of the user who created this client or customer

3232
clients[].userName
string

Name of the user who has created this client.

kalaivanan
clients[].typeId
integer

Unqiue ID of the client type/category.

0
clients[].typeName
string

Client category/type name

Service stations
clients[].lat
number

Latitude of the client location.

28.612964
clients[].long
number

Longitude of the client location.

77.268118
clients[].creationTime
integer

Client creatation time in Local Epoch Time stamp.

1700000000000
clients[].updationTime
integer

Last updated time against the client in Epoch Time.

1700000000000
clients[].creationTimeStr
string

Client creation time in string format

1700000000000
clients[].updationTimeStr
string

Client updation time in string format

1700000000000
clients[].viewRight
integer

view rights of the client. 0-public , 1-team , 2-manager

2
clients[].departments
array<object>

Details of Departments associated with the clients

example
clients[].departments[].id
string

Unqiue Id of the department

32
clients[].departments[].name
string

Name of the department

product team
clients[].departments[].contactPersonName
string

Name of the department contact person

sundaram
clients[].departments[].mobileNo
string

Department cotnact person mobile number

9349439334
clients[].departments[].emailId
string

Department cotnact person email Id

sales@mapmyindia.com
clients[].departments[].creationTime
string

Time at which this department is being added. EPoch time.

1700000000000
clients[].departments[].updationTime
string

Time at which this department is being upated last time. It is in Epoch time.

1700000000000
clients[].lastActivity
object

No field description in the source contract.

example
clients[].lastActivity.Status
integer

Last activity done by the user. 3- check-in , 4- check out, 5- client created.

4
clients[].lastActivity.time
integer

Time at which last activity is being carried out in EPOCH Time.

1700000000000
clients[].lastActivity.Lat
number

Last activity location latitude.

28.612964
clients[].lastActivity.Long
number

Last activity location Longitude.

77.269003
clients[].lastActivity.visitedUserId
integer

Unique ID of the user who has done the last activity against this client.

3223
clients[].lastActivity.vistedUserName
string

Name of the user who has done the last activity aginst this client.

Megha Soni
Response example
{
  "clients": [
    {
      "id": 3232,
      "status": 1,
      "name": "ABN pvt.ltd",
      "address": "237, okhla phase 3, new delhi -110020",
      "contactPersonName": "Dinesh",
      "emailId": "workmate@mapmyindia.com",
      "mobileNo": 9348332321,
      "userId": 3232
    }
  ]
}

Operate it safely

observe

This operation observes durable platform state. Preserve resource identifiers and account for pagination, delay, and eventual consistency.

Keep credentials and raw tokens out of source, client bundles, prompts, and logs.Record the operation ID, status, latency, retry count, and source contract version in traces.Classify 4xx responses before retrying; back off and add jitter for retryable 5xx or transport failures.Persist resource identifiers and apply commands exactly once in effect across retries and event replay.

Contract provenance

Source file
contenthub/dochub/mapmyindia-workmate-apis/custom/Client-Management.json
SHA-256
61d557dd95d6c5b53e7beff879c160d64a1a449abd0f1a5ed3b76f6e7ff467ce
Normalization
Fields are parsed from OpenAPI. Operational guidance and language samples are generated and labeled separately.