### Example GET Request for Bots

Source: https://developers.worksmobile.com/jp/docs/api-call

Example of a GET request to retrieve a list of bots.

```http
GET https://www.worksapis.com/v1.0/bots
```

--------------------------------

### Example GET Request for User Information

Source: https://developers.worksmobile.com/jp/docs/api-call

Example of a GET request to retrieve information for a specific user using their userId.

```http
GET /v1.0/users/{userId}
```

--------------------------------

### Example Query Parameters for User List

Source: https://developers.worksmobile.com/jp/docs/api-call

Example of a GET request to retrieve a user list, specifying domainId and count using query parameters.

```http
GET /v1.0/users?domainId=10000001&count=20
```

--------------------------------

### HTTP Request Example

Source: https://developers.worksmobile.com/jp/docs/partner-customer-invoice-detail-get

This is an example of the HTTP GET request to retrieve partner invoice details.

```http
https://www.worksapis.com/v1.0/partners/invoice-details
```

--------------------------------

### Example GET Request for Current User

Source: https://developers.worksmobile.com/jp/docs/api-call

Using the 'me' keyword in the path parameter allows calling the API for the authenticated user's resource.

```http
GET /v1.0/users/me
```

--------------------------------

### Get Partner Customers Response Example

Source: https://developers.worksmobile.com/jp/docs/partner-customer-list

This is an example of a successful response when retrieving a list of partner customers. It includes customer details and response metadata for pagination.

```json
{
  "customers": [
    {
      "tenantId": 10000001,
      "domainId": 10000001,
      "domain": "example.com",
      "productId": "STD_T",
      "companyName": "ワークスモバイルジャパン株式会社",
      "phoneNumber": "03-0000-0000",
      "timeZone": "Asia/Tokyo",
      "locale": "ja_JP",
      "enableActiveMxrecord": true,
      "enableActiveDomain": true,
      "domainType": "DOMAIN",
      "administrator": {
        "lastName": "ワークス",
        "firstName": "管理者",
        "id": "companyadmin",
        "privateEmail": "private.works@example.com",
        "cellphone": "090-0000-0000",
        "countryCode": "+81"
      },
      "partnership": {
        "status": "TRANSFER_READY",
        "customerCode": "asd123ada11",
        "enablePartnerProfileDisplay": true,
        "memo": "memo",
        "enableDevelopersAccess": true,
        "enableAdminAccess": true,
        "useOptionPlus": true
      }
    }
  ],
  "responseMetaData": {
    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="
  }
}
```

--------------------------------

### Example startTime and endTime Parameters

Source: https://developers.worksmobile.com/jp/docs/audit-log-download

Demonstrates the format for specifying the start and end times for log retrieval. The time range is limited to 31 days. Remember to URL-encode characters like '+' to '%2B'.

```http
startTime=2021-11-01T00:00:00%2B09:00&endTime=2021-11-30T23:59:59%2B09:00
```

--------------------------------

### Example SCIM User List Query

Source: https://developers.worksmobile.com/jp/docs/scim

Example of how to query a list of users using the SCIM API.

```http
GET https://www.worksapis.com/scim/v2/Users
```

--------------------------------

### Response Example for Option Product Order Settings

Source: https://developers.worksmobile.com/jp/docs/partner-customer-option-product-order-list

This example shows the structure of a successful response when retrieving option product order settings. It includes details like option product ID, sub-option ID, type, quantity, and apply date.

```json
{
  "optionProductOrders": [
    {
      "optionProductId": "ACV2",
      "subOptionId": "ACV201",
      "type": "APPLY",
      "quantity": null,
      "applyDate": "2021-11-01"
    },
    {
      "optionProductId": "SSTG2",
      "subOptionId": "SSTG202",
      "type": "APPLY",
      "quantity": null,
      "applyDate": "2021-11-01"
    }
  ]
}
```

--------------------------------

### Start Paid Service for Drive Option Product

Source: https://developers.worksmobile.com/jp/docs/partner-customer-option-product-orders-post

Use this to transition a Drive option product from trial to a paid service. Set the `type` to 'START_PAID_SERVICE' and provide the relevant `optionProductId`, `subOptionId`, and `applyDate`.

```json
{
  "optionProductId": "DRV",
  "subOptionId": "DRV_PS",
  "type": "START_PAID_SERVICE",
  "applyDate": "2021-11-01"
}
```

--------------------------------

### Option Product Usages Response Example

Source: https://developers.worksmobile.com/jp/docs/partner-customer-option-product-usage-get

This example demonstrates the structure of a successful HTTP 200 response, detailing the usage of different option products for a customer.

```json
{
  "optionProductUsages": [
    {
      "optionProductId": "SSTG2",
      "subOptionId": "SSTG202",
      "usedDate": "2021-11-01",
      "plan": "MONTHLY",
      "memberCount": 100,
      "quantity": null
    },
    {
      "optionProductId": "ACV2",
      "subOptionId": "ACV201",
      "usedDate": "2021-11-01",
      "plan": "MONTHLY",
      "memberCount": 100,
      "quantity": null
    }
  ]
}
```

--------------------------------

### Response Example for Option Products

Source: https://developers.worksmobile.com/jp/docs/partner-customer-option-product-get

This example shows the structure of a successful HTTP 200 response, detailing the applied option products with their IDs, quantities, and application times.

```json
{
  "optionProducts": [
    {
      "optionProductId": "ACV2",
      "subOptionId": "ACV201",
      "quantity": null,
      "appliedTime": "2021-11-01T00:00:00.000Z"
    },
    {
      "optionProductId": "SSTG2",
      "subOptionId": "SSTG202",
      "quantity": null,
      "appliedTime": "2021-11-01T00:00:00.000Z"
    }
  ]
}
```

--------------------------------

### HTTP Request Example

Source: https://developers.worksmobile.com/jp/docs/mail-get

Example of an HTTP GET request to retrieve a specific email by its ID.

```HTTP
GET
https://www.worksapis.com/v1.0/users/{userId}/mail/{mailId}
```

--------------------------------

### Update Free Plan to Paid Service Reservation (Advanced Plan)

Source: https://developers.worksmobile.com/jp/docs/partner-customer-subscription-reservation-update-patch

This example shows how to reserve a transition from a Free plan to an annual Advanced plan. Specify the desired apply date, plan, product ID, and domain for the upgrade. Note that the 'plan' should not be 'FREE' or 'TRIAL' when upgrading.

```json
{
  "applyDate": "2021-11-01",
  "plan": "MONTHLY",
  "maxMemberCount": null,
  "productId": "ADV",
  "domain": "example.com"
}
```

--------------------------------

### HTTP Request Example

Source: https://developers.worksmobile.com/jp/docs/contact-custom-property-get

Example of an HTTP GET request to retrieve a contact custom property.

```http
GET
https://www.worksapis.com/v1.0/contacts/custom-properties/{customPropertyId}
```

--------------------------------

### Create Folder Response Example

Source: https://developers.worksmobile.com/jp/docs/group-folder-file-root-folder-create

This is an example of a successful response when creating a folder. It includes details such as file ID, creation time, and file type.

```json
{
  "fileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",
  "parentFileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",
  "resourceLocation": 24101,
  "fileSize": 0,
  "fileName": "worksFolder",
  "filePath": "/worksFolder/",
  "fileType": "FOLDER",
  "createdTime": "2020-11-13T18:20:05.05+09:00",
  "modifiedTime": "2021-04-05T21:14:05.05+09:00",
  "accessedTime": "2021-04-05T21:14:05.05+09:00",
  "statuses": [],
  "hasPermission": true,
  "permissionRootFileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",
  "shared": false,
  "shareRootFileId": null
}
```

--------------------------------

### HTTP Request Example

Source: https://developers.worksmobile.com/jp/docs/directory-employment-type-orgunit-access-restrict-get

This is an example of the HTTP GET request to retrieve organizational unit access restrictions for an employment type.

```http
GET
https://www.worksapis.com/v1.0/directory/employment-types/{employmentTypeId}/orgunit-access-restrict
```

--------------------------------

### HTTP Request Example

Source: https://developers.worksmobile.com/jp/docs/directory-employment-type-get

Example of the HTTP GET request to retrieve an employment type by its ID. Ensure the employmentTypeId is URL-encoded.

```http
GET
https://www.worksapis.com/v1.0/directory/employment-types/{employmentTypeId}
```

--------------------------------

### User Creation Request Example

Source: https://developers.worksmobile.com/jp/docs/user-create

This example demonstrates the structure of a request to create a user, including personal information, organization details, contact information, and custom properties.

```json
{
  "domainId": 10000001,
  "userExternalKey": "USER_EXT_01",
  "email": "localpart@example.com",
  "userName": {
    "lastName": "ワークス",
    "firstName": "太郎"
  },
  "nickName": "nickname",
  "privateEmail": "private.works@example.com",
  "searchable": true,
  "organizations": [
    {
      "domainId": 10000001,
      "primary": true,
      "email": "localpart@example.com",
      "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",
      "orgUnits": [
        {
          "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",
          "primary": true,
          "positionId": "position-7027-4a02-b838-6f52b5e38db7",
          "isManager": true,
          "visible": true,
          "useTeamFeature": true
        }
      ]
    }
  ],
  "telephone": "031-1234-5678",
  "cellPhone": "090-1234-5678",
  "location": "green building",
  "task": "mytask",
  "messenger": {
    "protocol": "LINE",
    "messengerId": "lineid"
  },
  "birthdayCalendarType": "SOLAR",
  "birthday": "2000-01-01",
  "locale": "ja_JP",
  "hiredDate": "2020-01-01",
  "timeZone": "Asia/Tokyo",
  "customProperties": {
    "string_single": "hiking",
    "string_multi": [
      "hiking",
      "swimming"
    ],
    "string_single_option": "option_cooking",
    "string_multi_option": [
      "option_cooking",
      "option_piano"
    ],
    "date_single": "2025-03-23",
    "date_multi": [
      "2025-03-23",
      "2025-03-24"
    ],
    "integer_single": 123,
    "integer_multi": [
      123,
      456
    ],
    "link_single": {
      "text": "worksmobile",
      "link": "https://contact.worksmobile.com"
    },
    "link_multi": [
      {
        "text": "worksmobile",
        "link": "https://contact.worksmobile.com"
      },
      {
        "text": "line",
        "link": "https://www.line.me/"
      }
    ]
  },
  "relations": [
    {
      "relationUserId": "userfd-fc09-4a57-ab38-03dc6c425e09",
      "relationName": "Manager"
    }
  ],
  "activationDate": "2030-11-12T09:30:00+09:00",
  "employeeNumber": "employee1234"
}
```

--------------------------------

### Create Folder Response Example

Source: https://developers.worksmobile.com/jp/docs/drive-file-folder-create

This is an example of a successful response when creating a folder. It includes details about the newly created folder such as its ID, name, path, and timestamps.

```json
{
  "fileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",
  "parentFileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",
  "resourceLocation": 24101,
  "fileSize": 0,
  "fileName": "worksFolder",
  "filePath": "/folder/worksFolder/",
  "fileType": "FOLDER",
  "createdTime": "2020-11-13T18:20:05.05+09:00",
  "modifiedTime": "2021-04-05T21:14:05.05+09:00",
  "accessedTime": "2021-04-05T21:14:05.05+09:00",
  "statuses": [],
  "hasPermission": true,
  "permissionRootFileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",
  "shared": false,
  "shareRootFileId": null
}
```

--------------------------------

### Response Example for Get Mail Filter

Source: https://developers.worksmobile.com/jp/docs/mail-filter-get

This is an example of a successful HTTP 200 response, detailing the structure of a mail filter object.

```JSON
{
  "filter": {
    "filterId": 0,
    "folderId": 0,
    "from": "admin@example.com",
    "toCc": "tocc@example.com",
    "to": "to@example.com",
    "cc": "cc@example.com",
    "subject": "SubjectString",
    "body": "bodyString",
    "hasAttach": false,
    "highlightColor": "#e8f8fd",
    "isForwardEmail": false,
    "isMoveFolder": false,
    "isRead": false,
    "isColor": true,
    "isReplyFromMe": false,
    "isCalendarMail": false,
    "isImportant": false,
    "isDelete": false,
    "isApplyExistingMails": false
  }
}
```

--------------------------------

### Implicit Flow Response Example

Source: https://developers.worksmobile.com/jp/docs/auth-oauth

This is an example of a GET request URL when using the Implicit Flow. The 'access_token', 'id_token', and other parameters are returned in the fragment.

```http
GET https://example.com/redirect-url#access_token=jp1AAAAwQ...&id_token=eyJ0eXAiOiJKV...&scope=openid&expires_in=86400&token_type=Bearer&state=UmyR2sX9gO  

```

--------------------------------

### Response Example for Potential Customers

Source: https://developers.worksmobile.com/jp/docs/partner-potential-customers-get

This is an example of a successful response when retrieving potential customer data. It includes tenant and domain IDs, domain name, and product information.

```json
{
  "tenantId": 10000001,
  "domainId": 10000001,
  "domain": "example.com",
  "productId": "FR",
  "productIds": [
    "FR",
    "ROG_FR"
  ],
  "notHandledApps": [
    "ABC app",
    "XYZ app"
  ]
}
```

--------------------------------

### Create Folder Response Example

Source: https://developers.worksmobile.com/jp/docs/sharedrive-file-folder-create

This is an example of a successful response when creating a folder. It includes details about the newly created folder such as its ID, name, type, and timestamps.

```json
{
  "fileId": "ChExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",
  "parentFileId": "NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA",
  "resourceLocation": 24101,
  "fileSize": 0,
  "fileName": "mobile",
  "filePath": "/worksFolder/mobile/",
  "fileType": "FOLDER",
  "createdTime": "2020-11-13T18:20:05.05+09:00",
  "modifiedTime": "2021-04-05T21:14:05.05+09:00",
  "accessedTime": "2021-04-05T21:14:05.05+09:00",
  "statuses": [],
  "hasPermission": false,
  "permissionRootFileId": null,
  "shared": false,
  "shareRootFileId": null
}
```

--------------------------------

### Get User Contact Tag List Request Example

Source: https://developers.worksmobile.com/jp/docs/contact-tag-user-list

This is an example of an HTTP GET request to retrieve a user's contact tag list. Ensure you replace {userId} with the actual user ID. The Authorization header must include a valid Bearer token.

```http
GET https://www.worksapis.com/v1.0/users/{userId}/contact-tags
```

--------------------------------

### Response Example for Creating Option Product

Source: https://developers.worksmobile.com/jp/docs/partner-customer-option-product-create

This example shows the structure of a successful HTTP 201 response when creating a partner customer option product. It includes details like option product ID, sub-option ID, quantity, and applied time.

```json
{
  "optionProductId": "SSTG2",
  "subOptionId": "SSTG202",
  "quantity": null,
  "appliedTime": "2021-11-01T00:00:00.000Z"
}
```

--------------------------------

### Authorization Code Flow Response Example

Source: https://developers.worksmobile.com/jp/docs/auth-oauth

This is an example of a GET request URL when using the Authorization Code Flow. The 'code' and 'state' parameters are returned in the query parameters.

```http
GET https://example.com/redirect-url?code=GgWvoas...&state=aBcDeF  

```

--------------------------------

### Create Folder Request Example

Source: https://developers.worksmobile.com/jp/docs/drive-file-folder-create

This example shows the JSON payload required to create a new folder. Ensure the fileName is between 1 and 200 characters.

```json
{
  "fileName": "mobile"
}
```

--------------------------------

### Get Task Response Example

Source: https://developers.worksmobile.com/jp/docs/task-get

An example of a successful HTTP 200 response when retrieving a task. It includes details about assignees, assignor, completion condition, content, dates, status, and the task ID.

```json
{
  "assignees": [
    {
      "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c754x",
      "assigneeName": "Susan Nielsen",
      "status": "TODO"
    },
    {
      "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c756x",
      "assigneeName": "Assignee Name",
      "status": "TODO"
    }
  ],
  "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",
  "assignorName": "Assigner Name",
  "completionCondition": "MUST_ALL",
  "content": "タスク内容",
  "createdTime": "2024-04-04T04:52:06.405Z",
  "dueDate": null,
  "modifiedTime": "2024-04-04T05:41:52.624Z",
  "resourceLocation": 14101,
  "status": "TODO",
  "taskId": "95e426f5-9c85-4d28-9c41-f22950398c9c",
  "title": "タスク"
}
```

--------------------------------

### IMAP Mail Migration Status Response Example

Source: https://developers.worksmobile.com/jp/docs/mail-migration-imap-get

An example of a successful HTTP 200 response when retrieving IMAP mail migration status. It includes details like start time, total mail count, port, and current status.

```json
{
  "startedTime": "2024-03-12 13:43:58",
  "totalMailCount": 0,
  "port": 993,
  "completedTime": "",
  "importedEmail": "user1@example.com",
  "email": "",
  "useSsl": true,
  "status": "In progress"
}
```

--------------------------------

### Response Example for User Tasks

Source: https://developers.worksmobile.com/jp/docs/user-task-list

This example shows the structure of a successful response when retrieving a user's tasks. It includes a list of tasks and metadata for pagination.

```json
{
  "tasks": [
    {
      "assignees": [
        {
          "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c754x",
          "assigneeName": "Susan Nielsen",
          "status": "TODO"
        },
        {
          "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c756x",
          "assigneeName": "Assignee Name",
          "status": "TODO"
        }
      ],
      "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",
      "assignorName": "Assignor Name",
      "completionCondition": "MUST_ALL",
      "content": "タスク内容",
      "createdTime": "2024-04-04T04:52:06.405Z",
      "dueDate": null,
      "modifiedTime": "2024-04-04T05:41:52.624Z",
      "resourceLocation": 14101,
      "status": "TODO",
      "taskId": "95e426f5-9c85-4d28-9c41-f22950398c9c",
      "title": "タスク"
    }
  ],
  "responseMetaData": {
    "nextCursor": "H4sIAAAAAAAA_6tWSk4sSU3PL6r0TFGyUkopTda1MDAwM7UwN1LSUUouLS7Jz_UvSkktUrKqVsqHMJRyc3NzKpRqawHgjprNPQAAAA"
  }
}
```

--------------------------------

### Activate Partner Customer Response Example

Source: https://developers.worksmobile.com/jp/docs/partner-customer-activate

This is an example of a successful response when activating a partner customer. It includes tenant and domain details, product information, company details, and administrator and partnership information.

```json
{
  "tenantId": 10000001,
  "domainId": 10000001,
  "domain": "example.com",
  "productId": "STD_T",
  "companyName": "ワークスモバイルジャパン株式会社",
  "phoneNumber": "03-0000-0000",
  "timeZone": "Asia/Tokyo",
  "locale": "ja_JP",
  "enableActiveMxrecord": true,
  "enableActiveDomain": true,
  "domainType": "DOMAIN",
  "administrator": {
    "lastName": "ワークス",
    "firstName": "管理者",
    "id": "companyadmin",
    "privateEmail": "private.works@example.com",
    "cellphone": "090-0000-0000",
    "countryCode": "+81"
  },
  "partnership": {
    "status": "TRANSFER_READY",
    "customerCode": "asd123ada11",
    "enablePartnerProfileDisplay": true,
    "memo": "メモ",
    "enableDeveloperConsoleAccessControl": true,
    "enableAdminConsoleAccessControl": true,
    "useOptionPlus": true
  }
}
```

--------------------------------

### Event Components Object Example

Source: https://developers.worksmobile.com/jp/docs/calendar

Defines the structure for event components, including event ID, summary, start and end times with time zones, description, location, and transparency.

```json
{
    "eventComponents": [
        {
            "eventId": "EventID1234567890abcdefghijk",
            "summary": "イベントの例",
            "start": {
                "dateTime": "2023-05-14T08:00:00",
                "timeZone": "Asia/Tokyo"
            },
            "end": {
                "dateTime": "2023-05-14T09:00:00",
                "timeZone": "Asia/Tokyo"
            },
            "description" : "これはテストのイベントです。",
            "location" : "中央会議室",
            "transparency": "OPAQUE"
        }
    ]
}

```

--------------------------------

### File Download Execution Response Example

Source: https://developers.worksmobile.com/jp/docs/file-upload

Example of a successful file download execution response, showing the file content type and size.

```http
HTTP/1.1 200 OK
Content-Type: image/jpeg
Content-Length: 11
(FileData)
```

--------------------------------

### Response Example for External Browser Settings

Source: https://developers.worksmobile.com/jp/docs/security-external-browser-get

This is an example of a successful response when retrieving external browser settings. It indicates whether the external browser is enabled.

```json
{
  "domainId": 10000001,
  "useExternalBrowser": false
}
```