Skip to content

Update README.md, document getSignatures method parameters #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EmilioVar wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md, document getSignatures method parameters #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,22 @@ $response = $client->getSignatures(50);
##### Getting signatures with custom field "crm_id"

```php
$response = $client->getSignatures(100, 0, ['crm_id' => 'CUSTOM_ID'])
$response = $client->getSignatures(100, 0, ['crm_id' => 'CUSTOM_ID']);
```

**Parameters:**

- **`$limit`** (int): Maximum number of signatures to return in the response. In this example: `100`
- **`$offset`** (int): Number of records to skip from the beginning. Useful for pagination. In this example: `0` (start from the first record)
- **`$filters`** (array, optional): Associative array with filters to search for specific signatures. In this example: `['crm_id' => 'CUSTOM_ID']` filters by the custom field "crm_id"

**Usage examples:**
```php
// Get the first 100 signatures with a specific CRM ID
$response = $client->getSignatures(100, 0, ['crm_id' => 'CUSTOM_ID']);

// Get the next 50 signatures (pagination)
$response = $client->getSignatures(50, 100, ['crm_id' => 'CUSTOM_ID']);
```

### Get signature request
Expand Down